/* -*- mode: C; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
/* vim:set et sts=4: */
/* bus - The Input Bus
 * Copyright (C) 2008-2010 Peng Huang <shawn.p.huang@gmail.com>
 * Copyright (C) 2008-2010 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#if !defined (__IBUST_H_INSIDE__) && !defined (IBUST_COMPILATION)
#error "Only <ibust.h> can be included directly"
#endif

/**
 * SECTION: ibustenginedesc
 * @short_description:  Input method engine description data.
 * @title: IBustEngineDesc
 * @stability: Stable
 *
 * An IBustEngineDesc stores description data of IBustEngine.
 * The description data can either be passed to ibust_engine_desc_new(),
 * or loaded from an XML node through ibust_engine_desc_new_from_xml_node()
 * to construct IBustEngineDesc.
 *
 * However, the recommended way to load engine description data is
 * using ibust_component_new_from_file() to load a component file,
 * which also includes engine description data.
 *
 * @see_also: #IBustComponent, #IBustEngine
 *
 */

#ifndef __ENGINE_DESC_H_
#define __ENGINE_DESC_H_

#include "ibustserializable.h"
#include "ibustxml.h"

/*
 * Type macros.
 */

/* define GOBJECT macros */
#define IBUST_TYPE_ENGINE_DESC             \
    (ibust_engine_desc_get_type ())
#define IBUST_ENGINE_DESC(obj)             \
    (G_TYPE_CHECK_INSTANCE_CAST ((obj), IBUST_TYPE_ENGINE_DESC, IBustEngineDesc))
#define IBUST_ENGINE_DESC_CLASS(klass)     \
    (G_TYPE_CHECK_CLASS_CAST ((klass), IBUST_TYPE_ENGINE_DESC, IBustEngineDescClass))
#define IBUST_IS_ENGINE_DESC(obj)          \
    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), IBUST_TYPE_ENGINE_DESC))
#define IBUST_IS_ENGINE_DESC_CLASS(klass)  \
    (G_TYPE_CHECK_CLASS_TYPE ((klass), IBUST_TYPE_ENGINE_DESC))
#define IBUST_ENGINE_DESC_GET_CLASS(obj)   \
    (G_TYPE_INSTANCE_GET_CLASS ((obj), IBUST_TYPE_ENGINE_DESC, IBustEngineDescClass))

G_BEGIN_DECLS

typedef struct _IBustEngineDesc IBustEngineDesc;
typedef struct _IBustEngineDescPrivate IBustEngineDescPrivate;
typedef struct _IBustEngineDescClass IBustEngineDescClass;

/**
 * IBustEngineDesc:
 *
 * Input method engine description data.
 * You can get extended values with g_object_get_properties.
 * name: Name of the engine.
 * longname: Long name of the input method engine.
 * description: Input method engine description.
 * language: Language (e.g. zh, jp) supported by this input method engine.
 * license: License of the input method engine.
 * author: Author of the input method engine.
 * icon: Icon file of this engine.
 * layout: Keyboard layout
 * layout_variant: Keyboard variant
 * layout_option: Keyboard option
 * rank: Preference rank among engines, the highest ranked IME will put in
 * the front.
 * hotkeys: One or more hotkeys for switching to this engine, separated by
 *  semi-colon.
 * setup: Exec lists of the engine setup command.
 * version: Version number of the input method engine.
 */
struct _IBustEngineDesc {
    IBustSerializable parent;
    /* instance members */

    /*< public >*/
    /*< private >*/
    IBustEngineDescPrivate *priv;
};

struct _IBustEngineDescClass {
    IBustSerializableClass parent;
    /* class members */
};

GType            ibust_engine_desc_get_type      (void);

/**
 * ibust_engine_desc_new:
 * @name: Name of the engine.
 * @longname: Long name of the input method engine.
 * @description: Input method engine description.
 * @language: Language (e.g. zh, jp) supported by this input method engine.
 * @license: License of the input method engine.
 * @author: Author of the input method engine.
 * @icon: Icon file of this engine.
 * @layout: Keyboard layout
 * @returns: A newly allocated IBustEngineDesc.
 *
 * New a IBustEngineDesc.
 */
IBustEngineDesc  *ibust_engine_desc_new           (const gchar    *name,
                                                 const gchar    *longname,
                                                 const gchar    *description,
                                                 const gchar    *language,
                                                 const gchar    *license,
                                                 const gchar    *author,
                                                 const gchar    *icon,
                                                 const gchar    *layout);

/**
 * ibust_engine_desc_new_varargs:
 * @first_property_name: Name of the first property.
 * @Varargs: the NULL-terminated arguments of the properties and values.
 *
 * New a IBustEngineDesc.
 * ibust_engine_desc_new_varargs() supports the va_list format.
 * name property is required. e.g.
 * ibust_engine_desc_new_varargs("name", "ibust-foo", "language", "us", NULL)
 */
IBustEngineDesc  *ibust_engine_desc_new_varargs   (const gchar *first_property_name,
                                                 ...);


/**
 * ibust_engine_desc_new_from_xml_node:
 * @node: An XML node
 * @returns: A newly allocated IBustEngineDesc that contains description from
 * @node.
 *
 * New a IBustEngineDesc from an XML node.
 * <note><para>This function is called by ibust_component_new_from_file(),
 *  so developers normally do not need to call it directly.
 * </para></note>
 */
IBustEngineDesc  *ibust_engine_desc_new_from_xml_node
                                                (XMLNode        *node);
/**
 * ibust_engine_desc_get_name:
 * @info: An IBustEngineDesc
 * @returns: name property in IBustEngineDesc
 *
 * Return the name property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_name      (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_longname:
 * @info: An IBustEngineDesc
 * @returns: longname property in IBustEngineDesc
 *
 * Return the longname property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_longname  (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_description:
 * @info: An IBustEngineDesc
 * @returns: description property in IBustEngineDesc
 *
 * Return the description property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_description
                                                (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_language:
 * @info: An IBustEngineDesc
 * @returns: language property in IBustEngineDesc
 *
 * Return the language property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_language  (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_license:
 * @info: An IBustEngineDesc
 * @returns: license property in IBustEngineDesc
 *
 * Return the license property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_license   (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_author:
 * @info: An IBustEngineDesc
 * @returns: author property in IBustEngineDesc
 *
 * Return the author property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_author    (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_icon:
 * @info: An IBustEngineDesc
 * @returns: icon property in IBustEngineDesc
 *
 * Return the icon property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_icon      (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_layout:
 * @info: An IBustEngineDesc
 * @returns: layout property in IBustEngineDesc
 *
 * Return the layout property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_layout    (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_layout_variant:
 * @info: An IBustEngineDesc
 * @returns: keyboard variant property in IBustEngineDesc
 *
 * Return the keyboard variant property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_layout_variant
                                                (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_layout_option:
 * @info: An IBustEngineDesc
 * @returns: keyboard option property in IBustEngineDesc
 *
 * Return the keyboard option property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_layout_option
                                                (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_rank:
 * @info: An IBustEngineDesc
 * @returns: rank property in IBustEngineDesc
 *
 * Return the rank property in IBustEngineDesc.
 */
guint            ibust_engine_desc_get_rank      (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_hotkeys:
 * @info: An IBustEngineDesc
 * @returns: hotkeys property in IBustEngineDesc
 *
 * Return the hotkeys property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_hotkeys   (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_symbol:
 * @info: An IBustEngineDesc
 * @returns: symbol property in IBustEngineDesc
 *
 * Return the symbol property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_symbol    (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_setup:
 * @info: An IBustEngineDesc
 * @returns: setup property in IBustEngineDesc
 *
 * Return the setup property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_setup     (IBustEngineDesc *info);

/**
 * ibust_engine_desc_get_version:
 * @info: An IBustEngineDesc
 * @returns: version in IBustEngineDesc
 *
 * Return the version property in IBustEngineDesc. It should not be freed.
 */
const gchar     *ibust_engine_desc_get_version   (IBustEngineDesc *info);

/**
 * ibust_engine_desc_output:
 * @info: An IBustEngineDesc
 * @output: XML-formatted Input method engine description.
 * @indent: Number of indent (showed as 4 spaces).
 *
 * Output XML-formatted input method engine description.
 * The result will be append to GString specified in @output.
 */
void             ibust_engine_desc_output        (IBustEngineDesc *info,
                                                 GString        *output,
                                                 gint            indent);
G_END_DECLS
#endif
